Azure Communication Room Service (stable:2025-03-13)

2025/03/05 • 7 new methods

Rooms_Create (new)
Description :  Creates a new room.
Reference :  Link ¶

⚼ Request

POST:  /rooms
{
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
Repeatability-Request-ID:
{
Description: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-ID and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-ID is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. ,
Format: uuid ,
Required: False ,
}
string ,
Repeatability-First-Sent:
{
Description: If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
createRoomRequest:
{
Description: The create room request body. ,
Required: True ,
}
{
validFrom:
{
Description: The timestamp from when the room is open for joining. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. The default value is the current date time. ,
Format: date-time ,
Required: False ,
}
string ,
validUntil:
{
Description: The timestamp from when the room can no longer be joined. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. The default value is the current date time plus 180 days. ,
Format: date-time ,
Required: False ,
}
string ,
pstnDialOutEnabled:
{
Description: Set this flag to true if, at the time of the call, dial out to a PSTN number is enabled in a particular room. By default, this flag is set to false. ,
Required: False ,
}
boolean ,
participants:
{
Description: (Optional) Participants to be invited to the room. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
id:
{
Description: Unique identifier of a room. This id is server generated. ,
Required: True ,
}
string ,
createdAt:
{
Description: The timestamp when the room was created at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
validFrom:
{
Description: The timestamp from when the room is open for joining. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
validUntil:
{
Description: The timestamp from when the room can no longer be joined. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
pstnDialOutEnabled:
{
Description: Set this flag to true if, at the time of the call, dial out to a PSTN number is enabled in a particular room. By default, this flag is set to false. ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The Communication Services error. ,
}
{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
Rooms_List (new)
Description :  Retrieves all created rooms.
Reference :  Link ¶

⚼ Request

GET:  /rooms
{
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of rooms. ,
Required: True ,
}
[
{
id:
{
Description: Unique identifier of a room. This id is server generated. ,
Required: True ,
}
string ,
createdAt:
{
Description: The timestamp when the room was created at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
validFrom:
{
Description: The timestamp from when the room is open for joining. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
validUntil:
{
Description: The timestamp from when the room can no longer be joined. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
pstnDialOutEnabled:
{
Description: Set this flag to true if, at the time of the call, dial out to a PSTN number is enabled in a particular room. By default, this flag is set to false. ,
Required: True ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: If there are more rooms that can be retrieved, the next link will be populated. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The Communication Services error. ,
}
{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
Rooms_Get (new)
Description :  Retrieves an existing room by id.
Reference :  Link ¶

⚼ Request

GET:  /rooms/{roomId}
{
roomId:
{
Description: The id of the room requested. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique identifier of a room. This id is server generated. ,
Required: True ,
}
string ,
createdAt:
{
Description: The timestamp when the room was created at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
validFrom:
{
Description: The timestamp from when the room is open for joining. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
validUntil:
{
Description: The timestamp from when the room can no longer be joined. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
pstnDialOutEnabled:
{
Description: Set this flag to true if, at the time of the call, dial out to a PSTN number is enabled in a particular room. By default, this flag is set to false. ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The Communication Services error. ,
}
{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
Rooms_Update (new)
Description :  Update a room with given changes.
Reference :  Link ¶

⚼ Request

PATCH:  /rooms/{roomId}
{
roomId:
{
Description: The id of the room requested. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
updateRoomRequest:
{
Description: The update room request. ,
Required: True ,
}
{
validFrom:
{
Description: (Optional) The timestamp from when the room is open for joining. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
validUntil:
{
Description: (Optional) The timestamp from when the room can no longer be joined. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
pstnDialOutEnabled:
{
Description: (Optional) Set this flag to true if, at the time of the call, dial out to a PSTN number is enabled in a particular room. By default, this flag is set to false. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique identifier of a room. This id is server generated. ,
Required: True ,
}
string ,
createdAt:
{
Description: The timestamp when the room was created at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
validFrom:
{
Description: The timestamp from when the room is open for joining. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
validUntil:
{
Description: The timestamp from when the room can no longer be joined. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
pstnDialOutEnabled:
{
Description: Set this flag to true if, at the time of the call, dial out to a PSTN number is enabled in a particular room. By default, this flag is set to false. ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The Communication Services error. ,
}
{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
Rooms_Delete (new)
Description :  Delete a room.
Reference :  Link ¶

⚼ Request

DELETE:  /rooms/{roomId}
{
roomId:
{
Description: The id of the room to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The Communication Services error. ,
}
{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
Participants_List (new)
Description :  Get participants in a room.
Reference :  Link ¶

⚼ Request

GET:  /rooms/{roomId}/participants
{
roomId:
{
Description: The id of the room to get participants from. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of participants. ,
Required: True ,
}
[
{
rawId:
{
Description: Raw ID representation of the communication identifier. Please refer to the following document for additional information on Raw ID.
https://learn.microsoft.com/azure/communication-services/concepts/identifiers?pivots=programming-language-rest#raw-id-representation ,
Required: True ,
}
string ,
role:
{
Description: The role of a room participant. The default value is Attendee. ,
Enum:
{
Presenter: No description available. ,
Attendee: No description available. ,
Consumer: No description available. ,
Collaborator: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: If there are more participants that can be retrieved, the next link will be populated. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The Communication Services error. ,
}
{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
Participants_Update (new)
Description :  Update participants in a room.
Reference :  Link ¶

⚼ Request

PATCH:  /rooms/{roomId}/participants
{
roomId:
{
Description: The id of the room to update the participants in. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
updateParticipantsRequest:
{
Description: An updated set of participants of the room. ,
Required: True ,
}
{
participants:
{
Description: Participants to be updated. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$schema:
{
Description: Request response for updating participants. ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The Communication Services error. ,
}
{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}